Motion.GetGroupVelocity method

Gets a group's velocity in the selected coordinate system of an axis group.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsReturn<McGroupValue> GetGroupVelocity(
       int Index,
       McCoordSystem CoordSystem,
       McSource Source
)

Public Function GetGroupVelocity(
       Index As Integer,
       CoordSystem As McCoordSystem,
       Source As McSource
) As KsReturn(Of McGroupValue)

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

CoordSystem [in]

Type: McCoordSystem

A coordinate system.

Source [in]

Type: McSource

Selects the group's velocity value to read. mcCommandedValue is not supported.

Return value

Type: KsReturn<McGroupValue>

Returns a KsError code and an McGroupValue value.

Examples

N/A